Skip to content

Add readme#39

Merged
erom03 merged 1 commit intomainfrom
stt-docs
Apr 23, 2025
Merged

Add readme#39
erom03 merged 1 commit intomainfrom
stt-docs

Conversation

@erom03
Copy link
Contributor

@erom03 erom03 commented Apr 23, 2025

This documents contacting the projects websocket and how to get speech to text working.

Copilot AI review requested due to automatic review settings April 23, 2025 18:02
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request adds a README to document how to contact the project's WebSocket and configure speech-to-text integration using Vosk via Docker containers.

  • Adds instructions for contacting the WebSocket with guidelines on sending audio and text blobs.
  • Provides Docker run commands to start Vosk for both CPU and CUDA-enabled GPU environments.
  • Includes notes on audio preprocessing for effective speech-to-text processing.
Comments suppressed due to low confidence (2)

internal/listeners/README.md:3

  • [nitpick] Consider using consistent casing for 'WebSocket' throughout the documentation to enhance clarity.
When sending information over the webSocket, if it

internal/listeners/README.md:22

  • [nitpick] Consider capitalizing 'Go' and 'WebSocket' for consistency and to reflect proper naming conventions.
When sending audio over to the go project websocket,

Copy link
Contributor

@gavinmortensen gavinmortensen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

love this pt2

@erom03 erom03 merged commit 4161f91 into main Apr 23, 2025
1 check passed
@erom03 erom03 deleted the stt-docs branch April 23, 2025 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants